AlertsApi v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Email: Iberinform Web: Iberinform
Authentication
-
API Key (APIKeyHeader)
- Parameter Name: X-IBM-Client-Id, in: header.
-
API Key (ClientSecretHeader)
- Parameter Name: X-IBM-Client-Secret, in: header. Unique token directly related to the client contract
Default
get__alerts_count
Code samples
URL obj = new URL("https://$(catalog.host)/alertsapi/alerts/count");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const headers = {
'Accept':'application/json',
'X-IBM-Client-Id':'API_KEY',
'X-IBM-Client-Secret':'API_KEY'
};
fetch('https://$(catalog.host)/alertsapi/alerts/count',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://$(catalog.host)/alertsapi/alerts/count HTTP/1.1
Accept: application/json
'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$(catalog.host)/alertsapi/alerts/count', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'X-IBM-Client-Id': 'API_KEY',
'X-IBM-Client-Secret': 'API_KEY'
}
r = requests.get('https://$(catalog.host)/alertsapi/alerts/count', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY'
}
result = RestClient.get 'https://$(catalog.host)/alertsapi/alerts/count',
params: {
}, headers: headers
p JSON.parse(result)
# You can also use wget
curl -X GET https://$(catalog.host)/alertsapi/alerts/count \
-H 'Accept: application/json' \
-H 'X-IBM-Client-Id: API_KEY' \
-H 'X-IBM-Client-Secret: API_KEY'
GET /alerts/count
Example responses
200 Response
"{"contractId":107238,"totalAlerts":0}"
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | 200 OK | alertsCountDetails |
400 | Bad Request | 400 Bad Request | responseError |
401 | Unauthorized | 401 Authentication failed | responseError |
403 | Forbidden | 403 Forbidden | responseError |
404 | Not Found | 404 Not found | responseError |
500 | Internal Server Error | 500 Internal Server Error | responseError |
get__alertTypes
Code samples
URL obj = new URL("https://$(catalog.host)/alertsapi/alertTypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const headers = {
'Accept':'application/json',
'X-IBM-Client-Id':'API_KEY',
'X-IBM-Client-Secret':'API_KEY'
};
fetch('https://$(catalog.host)/alertsapi/alertTypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://$(catalog.host)/alertsapi/alertTypes HTTP/1.1
Accept: application/json
'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$(catalog.host)/alertsapi/alertTypes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'X-IBM-Client-Id': 'API_KEY',
'X-IBM-Client-Secret': 'API_KEY'
}
r = requests.get('https://$(catalog.host)/alertsapi/alertTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY'
}
result = RestClient.get 'https://$(catalog.host)/alertsapi/alertTypes',
params: {
}, headers: headers
p JSON.parse(result)
# You can also use wget
curl -X GET https://$(catalog.host)/alertsapi/alertTypes \
-H 'Accept: application/json' \
-H 'X-IBM-Client-Id: API_KEY' \
-H 'X-IBM-Client-Secret: API_KEY'
GET /alertTypes
Example responses
200 Response
"{"alertsTypes":[{"typeID":1,"typeDescription":"Masivo","reportingMode":"MASSIVE","payLoad":{"fileName":"Massive alert file name","numRegs":0,"changeDate":"2020-02-58 13:15:11"}},{"typeID":2,"typeDescription":"CNAE","reportingMode":"UNITARY","payLoad":{"companyId":0,"previousValue":"Previous value of the field monitorized","previousDescription":"Previous description of the field monitorized","currentValue":"Current value of the field monitorized","currentDescription":"Current description of the field monitorized","changeDate":"2020-02-58 13:15:11"}},{"typeID":3,"typeDescription":"Telefono","reportingMode":"UNITARY","payLoad":{"companyId":0,"previousValue":"Previous value of the field monitorized","previousDescription":"Previous description of the field monitorized","currentValue":"Current value of the field monitorized","currentDescription":"Current description of the field monitorized","changeDate":"2020-02-58 13:15:11"}},{"typeID":4,"typeDescription":"Forma Jurídica","reportingMode":"UNITARY","payLoad":{"companyId":0,"previousValue":"Previous value of the field monitorized","previousDescription":"Previous description of the field monitorized","currentValue":"Current value of the field monitorized","currentDescription":"Current description of the field monitorized","changeDate":"2020-02-58 13:15:11"}},{"typeID":5,"typeDescription":"Razon Social","reportingMode":"UNITARY","payLoad":{"companyId":0,"previousValue":"Previous value of the field monitorized","previousDescription":"Previous description of the field monitorized","currentValue":"Current value of the field monitorized","currentDescription":"Current description of the field monitorized","changeDate":"2020-02-58 13:15:11"}}],"totalAlertTypes":null}"
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | 200 OK | alertsTypesDetails |
400 | Bad Request | 400 Bad Request | responseError |
401 | Unauthorized | 401 Authentication failed | responseError |
403 | Forbidden | 403 Forbidden | responseError |
404 | Not Found | 404 Not found | responseError |
500 | Internal Server Error | 500 Internal Server Error | responseError |
get__alertTypes_{typeId}
Code samples
URL obj = new URL("https://$(catalog.host)/alertsapi/alertTypes/{typeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const headers = {
'Accept':'application/json',
'X-IBM-Client-Id':'API_KEY',
'X-IBM-Client-Secret':'API_KEY'
};
fetch('https://$(catalog.host)/alertsapi/alertTypes/{typeId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://$(catalog.host)/alertsapi/alertTypes/{typeId} HTTP/1.1
Accept: application/json
'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$(catalog.host)/alertsapi/alertTypes/{typeId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'X-IBM-Client-Id': 'API_KEY',
'X-IBM-Client-Secret': 'API_KEY'
}
r = requests.get('https://$(catalog.host)/alertsapi/alertTypes/{typeId}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY'
}
result = RestClient.get 'https://$(catalog.host)/alertsapi/alertTypes/{typeId}',
params: {
}, headers: headers
p JSON.parse(result)
# You can also use wget
curl -X GET https://$(catalog.host)/alertsapi/alertTypes/{typeId} \
-H 'Accept: application/json' \
-H 'X-IBM-Client-Id: API_KEY' \
-H 'X-IBM-Client-Secret: API_KEY'
GET /alertTypes/{typeId}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
typeId | path | integer(int32) | true | typeId |
Example responses
200 Response
"{"typeID":1,"typeDescription":"Masivo","reportingMode":"MASSIVE","payLoad":{"fileName":"Massive alert file name","numRegs":0,"changeDate":"2020-02-58 13:21:49"}}"
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | 200 OK | alertsTypeDetails |
400 | Bad Request | 400 Bad Request | responseError |
401 | Unauthorized | 401 Authentication failed | responseError |
403 | Forbidden | 403 Forbidden | responseError |
404 | Not Found | 404 Not found | responseError |
500 | Internal Server Error | 500 An internal error has occurred | responseError |
get__alertTypes_{typeId}_payload
Code samples
URL obj = new URL("https://$(catalog.host)/alertsapi/alertTypes/{typeId}/payload");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const headers = {
'Accept':'application/json',
'X-IBM-Client-Id':'API_KEY',
'X-IBM-Client-Secret':'API_KEY'
};
fetch('https://$(catalog.host)/alertsapi/alertTypes/{typeId}/payload',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://$(catalog.host)/alertsapi/alertTypes/{typeId}/payload HTTP/1.1
Accept: application/json
'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$(catalog.host)/alertsapi/alertTypes/{typeId}/payload', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'X-IBM-Client-Id': 'API_KEY',
'X-IBM-Client-Secret': 'API_KEY'
}
r = requests.get('https://$(catalog.host)/alertsapi/alertTypes/{typeId}/payload', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY'
}
result = RestClient.get 'https://$(catalog.host)/alertsapi/alertTypes/{typeId}/payload',
params: {
}, headers: headers
p JSON.parse(result)
# You can also use wget
curl -X GET https://$(catalog.host)/alertsapi/alertTypes/{typeId}/payload \
-H 'Accept: application/json' \
-H 'X-IBM-Client-Id: API_KEY' \
-H 'X-IBM-Client-Secret: API_KEY'
GET /alertTypes/{typeId}/payload
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
typeId | path | integer(int32) | true | typeId |
Example responses
200 Response
"{"fileName":"Massive alert file name","numRegs":0,"changeDate":"2020-02-58 13:26:53"}"
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | 200 OK | alertsTypePayloadDetails |
400 | Bad Request | 400 Bad Request | responseError |
401 | Unauthorized | 401 Authentication failed | responseError |
403 | Forbidden | 403 Forbidden | responseError |
404 | Not Found | 404 Not found | responseError |
500 | Internal Server Error | 500 Internal Server Error | responseError |
get__alerts
Code samples
URL obj = new URL("https://$(catalog.host)/alertsapi/alerts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const headers = {
'Accept':'application/json',
'X-IBM-Client-Id':'API_KEY',
'X-IBM-Client-Secret':'API_KEY'
};
fetch('https://$(catalog.host)/alertsapi/alerts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://$(catalog.host)/alertsapi/alerts HTTP/1.1
Accept: application/json
'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$(catalog.host)/alertsapi/alerts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'X-IBM-Client-Id': 'API_KEY',
'X-IBM-Client-Secret': 'API_KEY'
}
r = requests.get('https://$(catalog.host)/alertsapi/alerts', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY'
}
result = RestClient.get 'https://$(catalog.host)/alertsapi/alerts',
params: {
}, headers: headers
p JSON.parse(result)
# You can also use wget
curl -X GET https://$(catalog.host)/alertsapi/alerts \
-H 'Accept: application/json' \
-H 'X-IBM-Client-Id: API_KEY' \
-H 'X-IBM-Client-Secret: API_KEY'
GET /alerts
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | integer(int32) | false | limit |
Example responses
200 Response
"{"contractId":107238,"alerts":[{"id":"PdRB","typeId":2,"payload":{"companyId":3108923,"previousValue":null,"previousDescription":null,"currentValue":"0113","currentDescription":"CULTIVO DE HORTALIZAS RAICES Y TUBERCULOS","changeDate":"2020-12-363 15:46:23"}},{"id":"YnBw","typeId":4,"payload":{"companyId":3108923,"previousValue":null,"previousDescription":null,"currentValue":"33","currentDescription":"SLL","changeDate":"2020-12-363 15:46:23"}},{"id":"ZaOW","typeId":5,"payload":{"companyId":3108923,"previousValue":null,"previousDescription":null,"currentValue":"COLCHONES SANTA ANA","currentDescription":"","changeDate":"2020-12-363 15:46:23"}},{"id":"nlgj","typeId":3,"payload":{"companyId":3108923,"previousValue":null,"previousDescription":null,"currentValue":"916589632","currentDescription":"","changeDate":"2020-12-363 15:46:23"}},{"id":"a2KN","typeId":2,"payload":{"companyId":3639441,"previousValue":"0115","previousDescription":"CULTIVO DE TABACO","currentValue":"0116","currentDescription":"CULTIVO DE PLANTAS PARA FIBRAS TEXTILES","changeDate":"2020-12-363 16:55:29"}},{"id":"mjgX","typeId":2,"payload":{"companyId":7195876,"previousValue":"0113","previousDescription":"CULTIVO DE HORTALIZAS RAICES Y TUBERCULOS","currentValue":"0115","currentDescription":"CULTIVO DE TABACO","changeDate":"2020-12-363 16:55:29"}},{"id":"QKM1","typeId":2,"payload":{"companyId":7201224,"previousValue":"0116","previousDescription":"CULTIVO DE PLANTAS PARA FIBRAS TEXTILES","currentValue":"0114","currentDescription":"CULTIVO DE CA�A DE AZUCAR","changeDate":"2020-12-363 16:55:29"}}],"totalAlerts":7}"
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | 200 OK | alertsDetails |
400 | Bad Request | 400 Bad Request | responseError |
401 | Unauthorized | 401 Authentication failed | responseError |
403 | Forbidden | 403 Forbiden | responseError |
404 | Not Found | 404 Not Found | responseError |
500 | Internal Server Error | 500 Internal Server Error | responseError |
delete__alerts
Code samples
URL obj = new URL("https://$(catalog.host)/alertsapi/alerts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
const headers = {
'Accept':'application/json',
'X-IBM-Client-Id':'API_KEY',
'X-IBM-Client-Secret':'API_KEY'
};
fetch('https://$(catalog.host)/alertsapi/alerts',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE https://$(catalog.host)/alertsapi/alerts HTTP/1.1
Accept: application/json
'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://$(catalog.host)/alertsapi/alerts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'X-IBM-Client-Id': 'API_KEY',
'X-IBM-Client-Secret': 'API_KEY'
}
r = requests.delete('https://$(catalog.host)/alertsapi/alerts', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY'
}
result = RestClient.delete 'https://$(catalog.host)/alertsapi/alerts',
params: {
}, headers: headers
p JSON.parse(result)
# You can also use wget
curl -X DELETE https://$(catalog.host)/alertsapi/alerts \
-H 'Accept: application/json' \
-H 'X-IBM-Client-Id: API_KEY' \
-H 'X-IBM-Client-Secret: API_KEY'
DELETE /alerts
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | id |
Example responses
204 Response
{}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | 204 Successfully alert delete | Inline |
400 | Bad Request | 400 Bad Request | responseError |
401 | Unauthorized | 401 Authentication failed | responseError |
403 | Forbidden | 403 Forbidden | responseError |
404 | Not Found | 404 Not found | responseError |
500 | Internal Server Error | 500 An internal error has occurred | responseError |
Response Schema
Schemas
alertsDetails
"{"contractId":107238,"alerts":[{"id":"PdRB","typeId":2,"payload":{"companyId":3108923,"previousValue":null,"previousDescription":null,"currentValue":"0113","currentDescription":"CULTIVO DE HORTALIZAS RAICES Y TUBERCULOS","changeDate":"2020-12-363 15:46:23"}},{"id":"YnBw","typeId":4,"payload":{"companyId":3108923,"previousValue":null,"previousDescription":null,"currentValue":"33","currentDescription":"SLL","changeDate":"2020-12-363 15:46:23"}},{"id":"ZaOW","typeId":5,"payload":{"companyId":3108923,"previousValue":null,"previousDescription":null,"currentValue":"COLCHONES SANTA ANA","currentDescription":"","changeDate":"2020-12-363 15:46:23"}},{"id":"nlgj","typeId":3,"payload":{"companyId":3108923,"previousValue":null,"previousDescription":null,"currentValue":"916589632","currentDescription":"","changeDate":"2020-12-363 15:46:23"}},{"id":"a2KN","typeId":2,"payload":{"companyId":3639441,"previousValue":"0115","previousDescription":"CULTIVO DE TABACO","currentValue":"0116","currentDescription":"CULTIVO DE PLANTAS PARA FIBRAS TEXTILES","changeDate":"2020-12-363 16:55:29"}},{"id":"mjgX","typeId":2,"payload":{"companyId":7195876,"previousValue":"0113","previousDescription":"CULTIVO DE HORTALIZAS RAICES Y TUBERCULOS","currentValue":"0115","currentDescription":"CULTIVO DE TABACO","changeDate":"2020-12-363 16:55:29"}},{"id":"QKM1","typeId":2,"payload":{"companyId":7201224,"previousValue":"0116","previousDescription":"CULTIVO DE PLANTAS PARA FIBRAS TEXTILES","currentValue":"0114","currentDescription":"CULTIVO DE CA�A DE AZUCAR","changeDate":"2020-12-363 16:55:29"}}],"totalAlerts":7}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
contractId | number | false | none | none |
alerts | [object] | false | none | none |
id | string | false | none | none |
typeId | number | false | none | none |
payload | object | false | none | none |
companyId | number | false | none | none |
previousValue | any | false | none | none |
previousDescription | any | false | none | none |
currentValue | string | false | none | none |
currentDescription | string | false | none | none |
changeDate | string | false | none | none |
totalAlerts | number | false | none | none |
alertsCountDetails
"{"contractId":107238,"totalAlerts":0}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
contractId | number | false | none | none |
totalAlerts | number | false | none | none |
alertsTypesDetails
"{"alertsTypes":[{"typeID":1,"typeDescription":"Masivo","reportingMode":"MASSIVE","payLoad":{"fileName":"Massive alert file name","numRegs":0,"changeDate":"2020-02-58 13:15:11"}},{"typeID":2,"typeDescription":"CNAE","reportingMode":"UNITARY","payLoad":{"companyId":0,"previousValue":"Previous value of the field monitorized","previousDescription":"Previous description of the field monitorized","currentValue":"Current value of the field monitorized","currentDescription":"Current description of the field monitorized","changeDate":"2020-02-58 13:15:11"}},{"typeID":3,"typeDescription":"Telefono","reportingMode":"UNITARY","payLoad":{"companyId":0,"previousValue":"Previous value of the field monitorized","previousDescription":"Previous description of the field monitorized","currentValue":"Current value of the field monitorized","currentDescription":"Current description of the field monitorized","changeDate":"2020-02-58 13:15:11"}},{"typeID":4,"typeDescription":"Forma Jurídica","reportingMode":"UNITARY","payLoad":{"companyId":0,"previousValue":"Previous value of the field monitorized","previousDescription":"Previous description of the field monitorized","currentValue":"Current value of the field monitorized","currentDescription":"Current description of the field monitorized","changeDate":"2020-02-58 13:15:11"}},{"typeID":5,"typeDescription":"Razon Social","reportingMode":"UNITARY","payLoad":{"companyId":0,"previousValue":"Previous value of the field monitorized","previousDescription":"Previous description of the field monitorized","currentValue":"Current value of the field monitorized","currentDescription":"Current description of the field monitorized","changeDate":"2020-02-58 13:15:11"}}],"totalAlertTypes":null}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
alertsTypes | [object] | false | none | none |
typeID | number | false | none | none |
typeDescription | string | false | none | none |
reportingMode | string | false | none | none |
payLoad | object | false | none | none |
fileName | string | false | none | none |
numRegs | number | false | none | none |
changeDate | string | false | none | none |
totalAlertTypes | any | false | none | none |
alertsTypeDetails
"{"typeID":1,"typeDescription":"Masivo","reportingMode":"MASSIVE","payLoad":{"fileName":"Massive alert file name","numRegs":0,"changeDate":"2020-02-58 13:21:49"}}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
typeID | number | false | none | none |
typeDescription | string | false | none | none |
reportingMode | string | false | none | none |
payLoad | object | false | none | none |
fileName | string | false | none | none |
numRegs | number | false | none | none |
changeDate | string | false | none | none |
alertsTypePayloadDetails
"{"fileName":"Massive alert file name","numRegs":0,"changeDate":"2020-02-58 13:26:53"}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
fileName | string | false | none | none |
numRegs | number | false | none | none |
changeDate | string | false | none | none |
responseError
{
"code": "1404",
"message": "Resource not found",
"more_info": "This error is produced when ...",
"status": "404"
}
Payload error form
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
code | integer(int32) | false | none | Error code |
message | string | false | none | Error message |
more_info | string | false | none | Additional information |
status | string | false | none | HttpStatus |